Copyright: Copyright © 1995 Caladonia Systems Inc.
Citation: Copyright © 1995 Caladonia Systems Inc.


Contents

Overview

Printing a Project

Printing Single Files

Printing Single Routines

Properties

File Menu Commands

Visual Basic 5.0 Support


Overview

Code.Print for Visual Basic is designed to provide the developer with an affordable, capable tool to produce easily maintainable presentation quality source code documentation. Code.Print for Visual Basic provides the user with a rich set of printing options:

Header/Footer Options:

Date and Time

Project Name

File Name

Header/Footer Notes

Routine Name

Page Numbers

Continuous page numbering

Starting Page

Three header lines for additional notes

Three footer lines for notes

Page and Output Options:

Line Spacing

Top, Bottom, Left and Right Margin Control

Sort Output by Sub-Routine

Sort File by Sub-Routine

Serialize Backups

Page Breaks on New Routines

Fit Subroutine on Page

Background Printing

Bold Routine Name

Subroutine Index

Fonts:

Individual fonts, styles, and sizes can be designated for Header/Footer, Procedure Title, Comment, and Code lines. Any font available to the printer is available for your selection.


Header/Footer
Properties - Header/Footer

See also:

Properties

The Header/Footer properties determine the appearance and content of the sections seen at the top and bottom of the printed page in addition to the source code content.

The properties are described below:

Date and Time - Check this box to print Date and Time.

Project Name  - Check this box to print Project Name.

Project Name Text - If Project Name is checked you can enter text into the Project Name Text box.

File Name     - Check this box to print TXT file name.

Include Path  - Check this box to print the full path name of the file.

Header/Footer Notes - Check this box to print header and footer notes, if they exist.

Header/Footer Border Lines  - Check this box to print horizontal lines that separate the header and footer from the source code print area.

Print Routine Name  - Check this box to print the name of the routine on the title line.

Page Numbers  - Check this box to print page numbers.

Continuous  - Check this box to print page numbers without resetting to 1 at the start of a new file. This option works only when printing from project.

Starting Page - Enter the page number to start (default 1).

Date, Project, Filename, Header Notes, and Print Routine Name can be limited to print on the First Page Only for each file.  Check the Page 1 Only box next to the option you want to limit.


Printing a Project

See also:

Printing Single Files

Printing Single Routines

Code.Print for Visual Basic is capable of reading Visual Basic project files.  By selecting a project file in the File list box, Code.Print builds a sorted list of all printable files in the project and prints them.  This enables the user to print an entire application with one command.

To make your selection easier, set the combo box immediately below the Files list box to Projects

Select the project file you want in the FILE list box.

Press the Print button or select  PRINT (Ctrl-P) from the FILE menu to start printing.

When Code.Print for Visual Basic prints a project, page numbers increment continuously until the end of the print job if Continuous is checked in the Header/Footer Options group.  Otherwise page numbers reset to the starting page with each new text file.  Page number references in the index reflect whatever page numbering method was used.


Printing Single Files

See also:

Printing a Project

Printing Single Routines

Code.Print for Visual Basic can print any Visual Basic source file that is saved as text.  Code.Print can also print any non-Visual Basic text file but all output will be in the currently selected Code Font.

To make your selection easier, set the combo box immediately below the Files list box to the file type you want.

Select the file you want to print in the FILE list box.

Press the Print button or select  PRINT (Ctrl-P) from the FILE menu to start printing.


Printing Single Routines

See also:

Printing a Project

Printing Single Files

To print a single procedure within a code file, select the Visual Basic source code file you want in the FILE list box.

Code.Print will scan the file and make a sorted list of the procedures it finds.  This list appears in the PROCEDURES box.  The default procedure is [All].

Select the procedure or procedures you wish to print.  The list is capable of extended multiple selection.

Select [Declarations] to print only the declarations section of a source file.

Select [ALL] if you want to print all of the file.

Press the Print button or select  PRINT (Ctrl-P) from the FILE menu to start printing.

Code.Print for Visual Basic does not print an index when printing single routines.


Properties

Code.Print's printing options are set through the Properties page.  There are four tabs representing the different categories of options.  These sections are listed below.

Header/Footer

Fonts

Notes

Page Setup

In addition to the tabs there are four buttons along the bottom of the dialog.

The Close button exits the Properties page and returns the program to the main SDI form.  Note: Close does not save any changes you have made to the properties.  You must press the Apply or the Set Default button.  You can also close the dialog by pressing Esc or double clicking on the Control Box.

The Get Default button retrieves and sets the properties page to the default settings saved in the Code.Print INI file.

The Set Default button saves the current properties settings to the Code.Print INI file.  The default settings are always loaded at startup and can be retrieved at any time by pressing the Get Default button.

The Apply button applies the properties settings to the current running state of Code.Print.  Anything printed will use these settings.

Press the Help button for help on the properties page.


File Menu Commands

There are three commands available in the File Menu

Print - Select this option to start a print job.  You can also use the quick key Ctrl-P.

Print Setup - Select this option to access the Print Setup Dialog Box

Exit - Select this option to exit the program.  You can also use the quick key Ctrl-X or select CLOSE from the control box menu on the Code.Print for Visual Basic main window.


Fonts
Properties - Fonts

See also:

Properties

Individual fonts, styles, and sizes can be designated for Header/Footer, Procedure Title, Comment, and Code lines. Any font available to the printer is available for your selection.

To set the font for a section select the font desired from the section font list.  Set the desired size and style.  If no style check boxes are checked the font will appear as normal.

Note:

If the font size selected is not available Code.Print for Visual Basic will select the nearest usable size.


Notes
Properties - Notes

See also:

Properties

Header/Footer

Code.Print can print three lines of text in the top header section of each page and three lines of text in the footer section.  These notes are printed on each page unless otherwise limited by the first page only option.

Header and Footer notes are handy for repeated boilerplate text such as company information, disclaimers and copyright statements.

To create header footer notes edit the appropriate lines in the notes section.


Page Setup
Properties - Page Setup

See also:

Properties

Page Setup has a variety of properties primarily associated with page configuration such as margin control and page breaks.  A complete list of properties with descriptions is listed below:

Margins - Enter the size of the margins (Select inches or centimeters)

Sort Output - Check this box to print the routines in each file in alphabetical order.

Page Break on New Subroutine - Check this box to start a new page for each new procedure encountered.

Fit Subroutine on Page - Check this box to insure that any routine that is larger then can be printed on the current page will be printed starting at the top of the next page.  This option is not available if Page Break on New Subroutine is checked.

Line Spacing - Enter the line spacing you want (Default 1)

Print Subroutine Index - Check this box to print an index of the procedures printed during a print job.  The index lists the procedure name, file, and page number where the procedure was printed.  When printing a project, the index list is alphabetized based on the entire list of procedures encountered during the print run.  Indexes are not available when printing single procedures.

Print While Processing - Check this box to release output to the Print Manager as soon as each file is completed.  This option will allow you to split the output of large print job into several small print jobs.  This is useful if you have limited disk space for very large print spool files.  It will also allow you to print in background while Code.Print processes the files.

Bold Routine Name - Check this box to bold the name of each subroutine or function in the printout.  Make sure your code font is not set to bold, otherwise you will see no difference in the output.

Omit Form Declarations - Check this box to prevent Code.Print from printing form declarations when printing declaration header information from FRM files.

The following options are specific to working with TXT extension source code files that have been created with the Visual Basic Save Text command.

Sort File - Check this box to sort the TXT file by procedure and save it to disk.  (Useful for setting up the file for uses by editors, etc.  Code.Print for Visual Basic preserves the declarations section at the top of the file.  This process sorts TXT files only.  FRM and BAS files cannot be sorted.

Serialize Backups - When Code.Print for Visual Basic sorts a TXT file it creates a backup of the original TXT file.  If SERIALIZE BACKUPS is checked, Code.Print for Visual Basic copies the original file to a file with the next logical serialized extension.  For example, with a file called SAMPLE.TXT, say the last backup created is SAMPLE.V05. The next backup file that Code.Print for Visual Basic makes will be SAMPLE.V06.  Versions go from V00 to V99 and then start over.  If SERIALIZE BACKUPS is not checked the backup file always has the extension of BAK.


Visual Basic 4.0 Support
Visual Basic 5.0 Support

Code.Print provides full support for Visual Basic version 5.0.  All new language contructs as well as the new file types, VBP and CLS, CTL, PAG, DOB are fully supported.  In addition, when Code.Print is executed in Windows95 or Windows NT,  Code.Print provides full long file name support.